IApi.WriteAxisTouchProbeControl method

Writes the variable (#x60B8) of touch probe control.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError WriteAxisTouchProbeControl(
       int Index,
       ushort Value
)

Function WriteAxisTouchProbeControl(
       Index As Integer,
       Value As UShort
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Value

Type: short

The value to be written into the variable of touch probe control.

Return value

Type: KsError

A return code of a method.

Remarks

• To use this method, touch probe must be enabled using EnableTouchProbe.

• This function can be used only in Manual mode. See the McControlMode enum.

Usable EtherCAT states

ecatOP

Examples

N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace